<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>GROOPS - plotAxisType</title>

    <!-- JQuery and Popper -->
    <script src="https://code.jquery.com/jquery-3.4.1.slim.min.js" integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n" crossorigin="anonymous"></script>
    <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>

    <!-- Bootstrap -->
    <!-- https://getbootstrap.com/docs/4.1/examples/ -->
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js" integrity="sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6" crossorigin="anonymous"></script>
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh" crossorigin="anonymous">

    <!-- Mathjax -->
    <script type="text/x-mathjax-config">
    MathJax.Hub.Config({tex2jax: {inlineMath: [ ['$','$'] ],
                                  displayMath: [ ["\\[","\\]"] ],
                                  processEscapes: true},
                        TeX:     {Macros: {M: ["{\\mathbf #1}",1]},
                                  equationNumbers: {autoNumber: "all"}  }});
    </script>
    <script async src="https://cdn.jsdelivr.net/npm/mathjax@2.7.7/MathJax.js?config=TeX-AMS_CHTML" integrity="sha384-e/4/LvThKH1gwzXhdbY2AsjR3rm7LHWyhIG5C0jiRfn8AN2eTN5ILeztWw0H9jmN" crossorigin="anonymous"></script>

    <!-- lunr -->
    <script src="https://cdn.jsdelivr.net/npm/lunr@2.3.8/lunr.min.js" integrity="sha384-vRQ9bDyE0Wnu+lMfm57BlYLO0/XauFuKpVsZPs7KEDwYKktWi5+Kz3MP8++DFlRY" crossorigin="anonymous"></script>

    <!-- Mustache -->
    <script src="https://cdn.jsdelivr.net/npm/mustache@4.0.1/mustache.min.js" integrity="sha384-0PLEZVBpOQ+Kqw3anJWSNWvRxpEFt02tSpBvyRsA4WcvX/OTldWdXxGLVLvh954H" crossorigin="anonymous"></script>

    <!-- GROOPS Stylesheet -->
    <link rel="stylesheet" href="static/groops.css"/>

    <!-- icon -->
    <link rel="icon" href="static/groops_icon.png">

</head>
<body>
    <header>
        <nav class="navbar navbar-expand-lg navbar-dark bg-dark">
            <div class="container">
              <a class="navbar-brand" href="index.html"><img class="logo" src="static/groops_white.svg"></a>
              <div class="collapse navbar-collapse" id="mainNavbar">
                <ul class="navbar-nav mr-auto">
                  <li class="nav-item">
                    <a class="nav-link" href="programType.html">Programs</a>
                  </li>
                  <li class="nav-item">
                    <a class="nav-link" href="classes.html">Classes</a>
                  </li>
                  <li class="nav-item">
                    <a class="nav-link" href="general.parser.html">Parser</a>
                  </li>
                  <li class="nav-item">
                    <a class="nav-link" href="general.fileFormat.html">File Formats</a>
                  </li>
                </ul>
              </div>
                <form class="form-inline my-2 my-lg-0" action="search.html" id="searchTools">
                  <input class="form-control mr-sm-2" placeholder="Search" name="searchTerms" method="GET" value="" type="text" id="searchBox">
                  <button class="btn btn-secondary my-2 my-sm-0" type="submit" id="searchButton">Search</button>
                </form>
              <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#mainNavbar" aria-controls="mainNavbar" aria-expanded="false" aria-label="Toggle navigation" style="">
                <span class="navbar-toggler-icon"></span>
              </button>
            </div>
        </nav>
    </header>
    <main class="container px-0 pt-2 top-buffer">
        <div id="content" class="container">
            
<h1 id="plotAxisType">PlotAxis</h1><p>
Defines the style of the axes of <a class="groops-program" href="PlotGraph.html">PlotGraph</a>.
</p>

<h2>Standard</h2><p>
General axis for arbitrary input data.
</p>
<table class="table table-hover">
<tr class="table-primary"><th>Name</th><th>Type</th><th>Annotation</th></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">min</div></div></td><td>double</td><td>The minimum value of the axis. If no value is given, the minimum scale value is set automatically.</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">max</div></div></td><td>double</td><td>The maximum value of the axis. If no value is given, the maximum scale value is set automatically.</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">majorTickSpacing</div></div></td><td>double</td><td>The boundary annotation.</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">minorTickSpacing</div></div></td><td>double</td><td>The spacing of the frame tick intervals.</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">gridLineSpacing</div></div></td><td>double</td><td>The spacing of the grid line intervals</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">gridLine</div></div></td><td><a href="plotLineType.html">plotLine</a></td><td>The style of the grid lines.</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">unit</div></div></td><td>string</td><td>Naming unit to append to the axis values.</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">label</div></div></td><td>string</td><td>The description of the axis.</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">logarithmic</div></div></td><td>boolean</td><td>If set to 'yes', a logarithmic scale is used for the axis.</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config mustset">color</div></div></td><td><a href="plotColorType.html">plotColor</a></td><td>Setting the color of the axis bars and labels.</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">changeDirection</div></div></td><td>boolean</td><td>If set to 'yes', the directions right/up are changed to left/down.</td></tr>
</table>

<h2>Time</h2><p>
The input data are interpreted as MJD (modified Julian date).
The unit of the tick spacings should be appenend to the number and can be any of
<ul>

<li>Y (year, plot with 4 digits)
</li><li>
y (year, plot with 2 digits)
</li><li>
O (month, plot using <code>FORMAT_DATE_MAP</code>)
</li><li>
o (month, plot with 2 digits)
</li><li>
U (ISO week, plot using <code>FORMAT_DATE_MAP</code>)
</li><li>
u (ISO week, plot using 2 digits)
</li><li>
r (Gregorian week, 7-day stride from start of week <code>TIME_WEEK_START</code>)
</li><li>
K (ISO weekday, plot name of day)
</li><li>
D (date, plot using <code>FORMAT_DATE_MAP</code>)
</li><li>
d (day, plot day of month 0-31 or year 1-366, via <code>FORMAT_DATE_MAP</code>)
</li><li>
R (day, same as d, aligned with <code>TIME_WEEK_START</code>)
</li><li>
H (hour, plot using <code>FORMAT_CLOCK_MAP</code>)
</li><li>
h (hour, plot with 2 digits)
</li><li>
M (minute, plot using <code>FORMAT_CLOCK_MAP</code>)
</li><li>
m (minute, plot with 2 digits)
</li><li>
S (second, plot using <code>FORMAT_CLOCK_MAP</code>)
</li><li>
s (second, plot with 2 digits).
</li></ul>
</p><p>A secondary time axis can be added to specify larger intervals (e.g dates of hourly data).</p><p>Examples: Settings for Fig. <a href="plotAxisType.html#plotAxisTime1">plotAxisType:plotAxisTime1</a>: <strong class="groops-config-element">majorTickSpacing</strong>=<code>6H</code>, secondary: <strong class="groops-config-element">majorTickSpacing</strong>=<code>1D</code>.
<figure><img class="figure" style="width:100%;" src="../figures/plotAxisTime1.png" alt="plotAxisTime1"><figcaption class="center">Figure: Time axis for daily data.</figcaption></figure></p><p>Settings for Fig. <a href="plotAxisType.html#plotAxisTime2">plotAxisType:plotAxisTime2</a>: <strong class="groops-config-element">majorTickSpacing</strong>=<code>2d</code>, secondary: <strong class="groops-config-element">majorTickSpacing</strong>=<code>1O</code>, <strong class="groops-config-element">options</strong>=<code>FORMAT_DATE_MAP="o yyyy"</code>.
<figure><img class="figure" style="width:100%;" src="../figures/plotAxisTime2.png" alt="plotAxisTime2"><figcaption class="center">Figure: Time axis for monthly data.</figcaption></figure></p><p>Settings for Fig. <a href="plotAxisType.html#plotAxisTime3">plotAxisType:plotAxisTime3</a>: <strong class="groops-config-element">majorTickSpacing</strong>=<code>1o</code>, secondary: <strong class="groops-config-element">majorTickSpacing</strong>=<code>1Y</code>, <strong class="groops-config-element">options</strong>=<code>FORMAT_DATE_MAP="mm"</code>.
<figure><img class="figure" style="width:100%;" src="../figures/plotAxisTime3.png" alt="plotAxisTime3"><figcaption class="center">Figure: Time axis for yearly data.</figcaption></figure></p><p></p>
<table class="table table-hover">
<tr class="table-primary"><th>Name</th><th>Type</th><th>Annotation</th></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">min</div></div></td><td>time</td><td>The minimum value of the time axis. If no value is given, the minimum scale value is set automatically.</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">max</div></div></td><td>time</td><td>The maximum value of the time axis. If no value is given, the maximum scale value is set automatically.</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">majorTickSpacing</div></div></td><td>string</td><td>Y: year, o: month</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">minorTickSpacing</div></div></td><td>string</td><td>D: date, d: day</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">gridLineSpacing</div></div></td><td>string</td><td>H: clock, h: hour, m: minute, s: second</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">secondary</div></div></td><td>sequence</td><td>secondary time axis</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-1"><div class="h-100 config optional">majorTickSpacing</div></div></td><td>string</td><td>Y: year, o: month</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-1"><div class="h-100 config optional">minorTickSpacing</div></div></td><td>string</td><td>D: date, d: day</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-1"><div class="h-100 config optional">gridLineSpacing</div></div></td><td>string</td><td>H: clock, h: hour, m: minute, s: second</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config mustset">color</div></div></td><td><a href="plotColorType.html">plotColor</a></td><td>color of axis bars and labels</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">gridLine</div></div></td><td><a href="plotLineType.html">plotLine</a></td><td>The style of the grid lines.</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">changeDirection</div></div></td><td>boolean</td><td>right->left / up->down</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional-unbounded">options</div></div></td><td>string</td><td>adjust date format</td></tr>
</table>

<h2>Labeled</h2><p>
Axis with string labels. The coordinate system is based on the label indices (e.g. 0, 1, 2).
</p>
<table class="table table-hover">
<tr class="table-primary"><th>Name</th><th>Type</th><th>Annotation</th></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config mustset-unbounded">labels</div></div></td><td>string</td><td>tick labels (ticks are placed at their index. e.g. 0, 1, ..., 5)</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">min</div></div></td><td>expression</td><td>minimum value of the axis</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">max</div></div></td><td>expression</td><td>maximum values of the axis</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">orthogonalLabels</div></div></td><td>boolean</td><td>labels are oriented orthogonal to axis</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">gridLine</div></div></td><td><a href="plotLineType.html">plotLine</a></td><td>The style of the grid lines.</td></tr>
<tr class=""><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config mustset">color</div></div></td><td><a href="plotColorType.html">plotColor</a></td><td>set the color of the axis and labels</td></tr>
<tr class="table-light"><td class="m-0"><div class="h-100 config-tree depth-0"><div class="h-100 config optional">changeDirection</div></div></td><td>boolean</td><td>If set to 'yes', the directions right/up are changed to left/down.</td></tr>
</table>

        </div>
    </main>
</body>
</html>
